home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 1998 March / Macworld (1998-03) (Disk 1).dmg / Shareware World / Utilities / Text Processing / Alpha / Help / Frontier Help < prev    next >
Encoding:
Text File  |  1997-11-01  |  9.3 KB  |  238 lines  |  [TEXT/ALFA]
  1.  
  2.               Using Alpha as Frontier's external editor
  3.  
  4.                                Frontier menu 2.1.1
  5.                                 November 1997
  6.  
  7.  
  8. This document explains how to use Alpha as Frontier's external editor.
  9.  
  10. For help how to use Alpha as an HTML editor see the manual for HTML mode, 
  11. located in the folder HTML mode manual.
  12.  
  13. Please see the HTML mode home page, http://www.theophys.kth.se/~jl/Alpha.html
  14. for the latest version of HTML mode and Frontier menu. There you can also 
  15. download the HTML mode manual if you haven't got it already.
  16.  
  17. The code has been tested with Frontier 4.2.3, but it should work with at 
  18. least 4.2 and above. However, one very useful feature was introduced in 
  19. version 4.2.3. Beginning with this version Frontier adds the suffix .html 
  20. to the file name when sending it to Alpha. This makes Alpha automatically 
  21. switch to HTML mode, which is convenient when you're editing HTML.
  22.  
  23. Please send comments and bug reports to
  24.  
  25. Johan Linde, <jl@theophys.kth.se>
  26.  
  27. Acknowledgments
  28.  
  29. Almost immediately after I had released Frontier menu 1.0 I got to know that
  30. Danis Georgiadis <dmg@hyper.gr> also had written some code to integrate 
  31. Alpha and Frontier. He generously gave me his code to freely use together 
  32. with mine. In this version I have taken the parts from his code which 
  33. could easily be integrated with mine and which worked without problems. The 
  34. Frontier database browser and the Scripts menu are both made by him. 
  35. When I made the Frontier shell I used some of Danis' code and some from 
  36. Matlab mode by Stephen Merkowitz <merk@lnf.infn.it>.
  37.  
  38. What's new in version 2.1.1
  39.  
  40. • A startup and a shutdown script to be imported into Frontier have been 
  41. added. Together they solve a problem which sometimes prevented the windows to 
  42. be saved into Frontier's database. The shutdown script closes all open 
  43. Frontier windows in Alpha. No more launching of Frontier when closing 
  44. windows in Alpha. Thanks to Mike Carney <mike_carney@mediaone.net> for ideas 
  45. and some code snippets.
  46. • Various problems for windows with names containing brackets have been 
  47. fixed.
  48. • See also the version history.
  49.  
  50. Installation and configuring
  51.  
  52. Installing verbs into Frontier
  53.  
  54. The five files
  55. system.startup.clearAlphaFiles
  56. shutdown.closeAlphaWindows
  57. system.verbs.apps.Alpha
  58. user.html.editors.Alpha
  59. user.Alpha
  60. must be imported into Frontier. You find these in the folder
  61. Frontier verbs. Just double-click the files to import them. Frontier 
  62. will ask for a name of the imported objects. Use the ones suggested.
  63.  
  64. Upgrading from version 2.0.x
  65. Only the two files
  66. system.startup.clearAlphaFiles
  67. shutdown.closeAlphaWindows
  68. have to be imported into Frontier. The other three files have not changed 
  69. since version 2.0.x.
  70.  
  71. Upgrading from version 1.0
  72. All five files have to be imported into Frontier. The ones distributed with 
  73. Frontier menu 1.0 are not compatible with Frontier menu 2.1.
  74.  
  75. Other necessary changes to the Frontier database
  76.  
  77. There are also a few more changes you must do in Frontier:
  78. • Change the path in user.odbEditors.TextEditor to the path to Alpha, 
  79. otherwise Frontier will use the default editor BBEdit.
  80. • Similarly change the path in system.verbs.apps.Alpha.appinfo.path
  81. • A small change must be made to the verb suites.odbEditor.editors.Text.edit
  82.  
  83. The last lines reads
  84.  
  85. bundle «send an Apple Event to the editor to open the temp file
  86.     «use an open protocol that's implemented by BBEdit 4.0 and greater
  87.         «the extra parameter to the odoc event is Frontier's app id
  88.     appleEvent (ideditorapp, 'aevt', 'odoc', '----', alias (tempfile), 'FSnd', Frontier.id)
  89.     
  90. Change them to 
  91. bundle «send an Apple Event to the editor to open the temp file
  92.     if defined(Alpha.id) && ideditorapp == Alpha.id
  93.         Alpha.edit(tempfile)
  94.     else
  95.         «use an open protocol that's implemented by BBEdit 4.0 and greater
  96.             «the extra parameter to the odoc event is Frontier's app id
  97.         appleEvent (ideditorapp, 'aevt', 'odoc', '----', alias (tempfile), 'FSnd', Frontier.id)
  98.  
  99. This change is needed because Alpha doesn't understand the Apple event used 
  100. in the last line. Hopefully Alpha will understand it in the future so that 
  101. you don't have to make this change in the future. If you decide to switch 
  102. back to your previous editor you don't have to undo the above change. It 
  103. will work as before with any other editor.
  104.  
  105. Inserting the Frontier menu in the menu bar
  106.  
  107. The Frontier menu doesn't automatically appear in the menu bar. To insert 
  108. it in the menu bar select Frontier menu in the submenu Config -> Global -> 
  109. Package Menus.
  110.  
  111. Opening a Frontier text window in Alpha
  112.  
  113. Text windows in Frontier can be opened in Alpha using Edit with App in 
  114. Frontier's Main menu. Whenever you save changes the Frontier database is 
  115. automatically updated. If you use 'Save as...' in Alpha the new file is 
  116. connected to the same location in the Frontier database as the old one.
  117. Thus, there is hardly any point in doing 'Save as...'.
  118.  
  119. You can also use the Frontier database browser, see below.
  120.  
  121. Frontier menu
  122.  
  123. Switch to Frontier - Launches Frontier or brings it to front if already 
  124.                      running.
  125.  
  126. View in Browser - Makes Frontier render the page and sends it to the 
  127.                   browser for previewing. This is the same as 'View in 
  128.                   Browser' in Frontier's Web menu. This should only be used 
  129.                   for files opened from Frontier. Other HTML files are sent 
  130.                   to the browser using 'Send File to Browser' in the HTML 
  131.                   menu.
  132.  
  133. Frontier Shell -  Opens a shell window where you can run Frontier scripts, 
  134.                   see below.
  135.                   
  136. Browse -          Opens a Frontier browser at different points in the database.
  137.                   Use Add… and Remove… to edit this menu.
  138.  
  139. Open -               Opens a Frontier window in Frontier. Use Add… and Remove… to 
  140.                   edit this menu.
  141.  
  142. Scripts Menu -       Rebuilds the Scripts menu and loads the script corresponding 
  143.                   to the menu items.
  144.  
  145. Preferences… -    To set your preferences for Frontier. Currently you can 
  146.                   choose if you want to automatically launch Frontier when 
  147.                   you launch Alpha. This is not done by default.
  148.  
  149. Scripts menu
  150.  
  151. The Scripts menu is a menu which you define inside Frontier in the same way as 
  152. you define shared menus for other applications. (The Scripts menu has the 
  153. cowboy menu icon like the Frontier scripts in the Finder.) The menu definition 
  154. must be in user.Alpha.menubar. Alpha does not support menu sharing. Therefore 
  155. there are a few things which differ from how shared menu work. In particular:
  156.  
  157. • If you launch Frontier after Alpha the menu it not automatically inserted 
  158. in the menubar. You have to use Rebuild Scripts Menu to insert it.
  159. • Whenever you modify the menu you have to use Rebuild Scripts Menu to 
  160. rebuild it. Note! This has also to be done when you modify a script belonging 
  161. to a menu item.
  162. • Keybindings for the menu items must be defined the way Alpha defines 
  163. keybindings. Alpha uses certain meta characters to define menu items. See 
  164. the section Menus, User Defined in the general manual.
  165.  
  166. Frontier database browser
  167.  
  168. The Frontier database browser lets you navigate through Frontier's 
  169. database without leaving Alpha. You can also open Frontier windows in 
  170. Alpha without leaving Alpha. In the browser windows, tables are red, text 
  171. windows are green, and everything else is blue. To navigate the windows 
  172. you can use key shortcuts similar to those used to navigate Finder windows.
  173.  
  174. uparrow -         move up one line
  175.  
  176. downarrow -        move down one line
  177.  
  178. rightarrow -    rightarrow on a table displays the content of the table.
  179.  
  180. leftarrow -        leftarrow on a table hides the content of the table.
  181.  
  182. cmd uparrow -    opens the parent table in a new window.
  183.  
  184. cmd-opt uparrow - opens the parent table in a new window and closes the 
  185.                   current window.
  186.  
  187. cmd downarrow -    cmd downarrow on a table opens a new window with the 
  188.                 content of that table.
  189.  
  190. cmd-opt downarrow - cmd-opt downarrow on a table opens a new window with 
  191.                 the content of that table and closes the current window.
  192.  
  193. return -        opens the selected object for editing. Text objects are opened 
  194.                 in Alpha, and most other things are opened in Frontier.
  195.  
  196. Frontier shell
  197.  
  198. The Frontier shell is an alternative to the Frontier Quick Script window 
  199. for those who like a command history. Type a command and hit return to have it 
  200. executed in Frontier. The return value is then displayed on the next line.
  201.  
  202. You move up and down the command history using control-uparrow and 
  203. control-downarrow.
  204.  
  205. Control-u erases the current line.
  206.  
  207. WARNING! Don't send commands which will make Frontier open an alert window, 
  208. like e.g. dialog.notify. If this window is hidden behind your other 
  209. windows it will freeze your machine with command-option-escape as the only 
  210. way out.
  211.  
  212. Version history
  213.  
  214. 2.1.1, 3 November 1997 [update of version 2.0.1]
  215. • The same as version 2.1 but for Alpha 7.0.
  216.  
  217. 2.1, 3 November 1997 [update of version 2.0]
  218. • A startup and a shutdown script to be imported into Frontier have been 
  219. added. Together they solve a problem which sometimes prevented the windows to 
  220. be saved into Frontier's database. The shutdown script closes all open 
  221. Frontier windows in Alpha. Thanks to Mike Carney <mike_carney@mediaone.net> 
  222. for ideas and some code snippets.
  223. • Various problems for windows with names containing brackets have been 
  224. fixed.
  225.  
  226. 2.0.1, 19 October 1997
  227. • Updated to be compatible with Alpha 7.0.
  228.  
  229. 2.0, 17 August 1997
  230. • Added a Frontier shell.
  231. • Added database browser and a Browse submenu.
  232. • Added the Open submenu.
  233. • Added Scripts menu, which is defined in Frontier as with other apps.
  234. • 'Save as...' works now.
  235.  
  236. 1.0, 20 July 1997
  237. First public release.
  238.